Block Hooks API: Move ignoredHookedBlocks metadata injection logic #6604

tjcafferkey · 2024-05-22T11:14:19Z

Trac ticket: https://core.trac.wordpress.org/ticket/60759

Testing instructions:

Add the below code to your site.
Load the navigation block and check it renders in the editor/frontend
In the editor, update the navigation by adding another page and saving
Check the wp_postmeta table to see if core/loginout has been added to a row with the meta_key => _wp_ignored_hooked_blocks

function register_logout_block_as_navigation_last_child( $hooked_blocks, $position, $anchor_block, $context ) {
	if ( $anchor_block === 'core/navigation' && $position === 'last_child' ) {
		$hooked_blocks[] = 'core/loginout';
	}

	return $hooked_blocks;
}

add_filter( 'hooked_block_types', 'register_logout_block_as_navigation_last_child', 10, 4 );

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

src/wp-includes/blocks.php

src/wp-includes/default-filters.php

src/wp-includes/blocks.php

tjcafferkey · 2024-05-22T11:22:15Z

cc @ockham

github-actions · 2024-05-22T11:27:31Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

The Plugin and Theme Directories cannot be accessed within Playground.
All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

src/wp-includes/blocks.php

ockham · 2024-05-22T14:35:23Z

This is shaping up nicely! 😄

ockham · 2024-05-22T14:49:43Z

We have some test coverage in https://github.com/WordPress/gutenberg/blob/6108134aae75d1bd4826256490c609cb29044cd8/phpunit/blocks/block-navigation-block-hooks-test.php that we can probably copy over (with some small tweaks).

github-actions · 2024-05-23T13:02:07Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props bernhard-reiter, tomjcafferkey.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

src/wp-includes/blocks.php

tests/phpunit/tests/blocks/updateIgnoredHookedBlocksPostMeta.php

src/wp-includes/blocks.php

tests/phpunit/tests/blocks/updateIgnoredHookedBlocksPostMeta.php

ockham

Thank you very much, this is looking great! 🚀 Especially appreciate the test coverage, good thinking to add test cases for missing post ID and type 👍

Apologies for the number of notes I left, most of it is minor and/or coding standards compliance stuff 😬

tjcafferkey · 2024-05-24T09:12:26Z

@ockham I've addressed all your comments aside from the one we're going to address in a separate PR. I've also had to fix some merge conflicts with #6358

ockham · 2024-05-27T09:08:02Z

@ockham I've addressed all your comments aside from the one we're going to address in a separate PR. I've also had to fix some merge conflicts with #6358

Awesome, thank you very much!

We'll need to land the GB counterpart PR first; I've approved it, you wanna do the honors?

After that, we'll still need to wait for the code to be sync'd over to Core, so that the built Navigation block code in Core is updated and the "old" filter isn't still being added there if the new one is present. As always, the package sync will happen before Feature Freeze (i.e. next Tue, June 4), but probably only after the GB RC is released (this Friday). This means we'll likely land this PR on Monday 🙂

ockham · 2024-05-27T11:49:35Z

We'll need to land the GB counterpart PR first; I've approved it, you wanna do the honors?

I remembered you won't be able to do so today, so I want ahead and merged it 😬 Hope that's okay!

ockham · 2024-06-03T12:04:47Z

Committed to Core in https://core.trac.wordpress.org/changeset/58291.

tjcafferkey mentioned this pull request May 22, 2024

Block Hooks API: Harmonize ignoredHookedBlocks metadata injection logic #6550

Closed

tjcafferkey commented May 22, 2024

View reviewed changes

src/wp-includes/blocks.php Outdated Show resolved Hide resolved

tjcafferkey commented May 22, 2024

View reviewed changes

src/wp-includes/blocks.php Show resolved Hide resolved

tjcafferkey commented May 22, 2024

View reviewed changes

src/wp-includes/default-filters.php Show resolved Hide resolved

tjcafferkey commented May 22, 2024

View reviewed changes

src/wp-includes/blocks.php Outdated Show resolved Hide resolved

ockham reviewed May 22, 2024

View reviewed changes

src/wp-includes/blocks.php Outdated Show resolved Hide resolved

tjcafferkey mentioned this pull request May 23, 2024

Navigation block: Check for update_ignored_hooked_blocks_postmeta in core WordPress/gutenberg#61903

Merged

tjcafferkey marked this pull request as ready for review May 23, 2024 13:01